Skip to main content

Uplisting

How to set-up OAuth app​

  1. To get access to the oAuth credentials, reach out to the uplisting API support / Partnerships team (partner@uplisting.io).

  2. Please ask them to set the Redirect URL to https://dev.calry.app/api/v1/oauth/callbackfor development environment and https://prod.calry.app/api/v1/oauth/callback for production environment.

  3. Now, go to Calry webapp > OAuth > '+ New OAuth app'. Select Uplisting from the drop down in Integration type. Paste the client_id and client_secret from step 1.

  4. Paste this as the scope: calendar:read calendar:write properties:read properties:write reviews:read bookings:read bookings:create bookings:update custom_booking_attributes:read custom_booking_attributes:write messaging:read messaging:write offline_access

  1. Finally click on 'Create'.

How to authenticate the integration​

We'll use a test app, Acme AI, to show how an end-user can authenticate the integration between Uplisting and Acme AI.

  1. Go to Settings > Integrations section within Acme AI app.

  2. Among the list of Integrations, click on Uplisting's logo and you will be redirected to the Authentication Screen as shown below.

    uplisting auth 1

  3. Now switch over to your Uplisting Account in a new tab. Go to ‘Settings > Connect > API Key’ section as shown in below images. Generate the API key and copy it to your clipboard.

    uplisting auth 2

    uplisting auth 3

    uplisting auth 4

  4. Paste it back into the Authentication screen (from Step 2) and click Connect.

    • If you're using OAuth, proceed with signing in to your account.
    • If you're using API key authentication, paste your API key into the provided field.
  5. Once the authentication is successful, you'll see a confirmation message indicating that the integration has been connected successfully. You will then be automatically redirected back to the Acme app.

Note​

For messaging apis, oAuth setup is mandatory.


If you have any questions or need help, don't hesitate to reach out at mail@calry.app.